package net.linku.exception;

import java.io.Serializable;

/**
 * BizExpCode 接口定义了业务异常代码的规范。
 * 实现该接口的类将包含特定的错误代码和错误消息，
 * 以便在处理业务异常时提供详细的信息。
 *
 * @version 1.0
 * @date 2024/7/15
 *
 * <p>接口定义了两个方法：</p>
 * <ul>
 *     <li>{@code getErrorCode()}：获取错误代码，返回类型为 {@link String}。</li>
 *     <li>{@code getErrorMsg()}：获取错误消息，返回类型为 {@link String}。</li>
 * </ul>
 *
 * <p>实现该接口的类需要提供具体的错误代码和消息，以用于业务逻辑中的异常处理。</p>
 *
 * <pre>
 * 示例实现：
 * {@code
 * public class MyBizExpCode implements BizExpCode {
 *     @Override
 *     public String getErrorCode() {
 *         return "ERR001";
 *     }
 *
 *     @Override
 *     public String getErrorMsg() {
 *         return "具体的错误消息描述";
 *     }
 * }
 * }
 * </pre>
 *
 * <p>实现类可以根据具体业务需求定义相应的错误代码和消息。</p>
 *
 * @see Serializable
 */
public interface BizExpCode extends Serializable {

    /**
     * 获取错误代码。
     *
     * @return 错误代码，返回类型为 {@link String}。
     */
    String getErrorCode();

    /**
     * 获取错误消息。
     *
     * @return 错误消息，返回类型为 {@link String}。
     */
    String getErrorMsg();
}
